DOC-17061: Replace remote_include with vendored includes#23297
Open
ebembi-crdb wants to merge 4 commits into
Open
DOC-17061: Replace remote_include with vendored includes#23297ebembi-crdb wants to merge 4 commits into
ebembi-crdb wants to merge 4 commits into
Conversation
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
Files changed:
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
4 tasks
rmloveland
requested changes
May 19, 2026
Contributor
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
@ebembi-crdb thank you for putting this together! wanted to drop some high level comments based on a quick glance with codex in a local worktree before the Docs Weekly meeting tomorrow where we will discuss this work further:
- this does not remove all
remote_includetags, it leaves a bunch in e.g._includes/v26.2/misc/tooling.md(to see the remaining uses ofremote_includerunrg -n 'remote_include https://raw\.githubusercontent\.com/cockroachdb/cockroach' src/current) - this appears to be a one-time copying of files, but there is no tooling added to automate this process. any PR we merge needs to at least reference how we plan to use scripts/tools to automate this process, even if those tools actually live elsewhere (eg in CI/GH actions, and not the docs repo itself)
obv these can be fixed! just adding here for visibility / discussion for meeting tomorrow
Contributor
|
@ebembi-crdb can you please rebase this on that PR also adds a once you rebase can you please update this PR to pull in the included session settings file from that PR? |
Contributor
|
there are two types of
i am going to make separate PRs for those that will re-use the same file pattern you're using here, e.g., (and something similar for the example app includes) also I will do a detailed review of this PR today (2026-05-28) |
rmloveland
requested changes
May 28, 2026
| @@ -5,4 +5,4 @@ toc: true | |||
| docs_area: reference.logging | |||
| --- | |||
|
|
|||
| {% remote_include https://raw.githubusercontent.com/cockroachdb/cockroach/{{ page.release_info.crdb_branch_name }}/docs/generated/eventlog.md %} | |||
Contributor
There was a problem hiding this comment.
codex tells me these eventlog.md files are now stale vs what is in cockroachdb/cockroach and need to be updated
please update the file with the latest versions
PS we will need to make some tickets in EDUENG queue to update going forward, I am planning to do that once we merge these PRs
Contributor
|
@ebembi-crdb this one is close, please see my other comments re:
otherwise overall LGTM on my end i plan to file an issue in EDUENG re: maintaining this sync going forward - if you think the bash script is the way forward, so be it. I'll still file the EDUENG issue tho so we can re-assess and make an official decision |
This was referenced May 28, 2026
Vendor 88 machine-generated doc files from cockroachdb/cockroach into
_includes/cockroach-generated/ and update 55 versioned pages to use
local {% include %} instead of {% remote_include %} directives.
This eliminates runtime dependencies on raw.githubusercontent.com for
generated reference docs (cluster settings, event log, functions and
operators, log formats, logging).
Part of DOC-17061.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Resolve review feedback by replacing all remaining remote_include references to cockroachdb/cockroach in tooling.md files (v20.2–v26.2) and latest_operator_version.md with vendored values. Add vendor_cockroach_docs.sh to automate syncing generated docs and driver/ORM version strings from the cockroach repo. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…n vars - Update stale eventlog.md files for all versions (release-23.1 through release-26.2) with latest from cockroachdb/cockroach - Add vendored includes for v26.3 (generated docs, tooling versions, session vars) - Replace remote_include tags in v26.3 doc pages with local includes - Vendor session_vars table content for v26.2 and v26.3 - Replace remote_include in v26.2 and v26.3 session-vars.md with vendored local include - Update vendor script to skip operator version (now maintained manually per #23393) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
ebembi-crdb
force-pushed
the
replace-remote-includes
branch
from
824753b to
8e058a5
Compare
Contributor
Author
Changes made to address review feedback
Verification
Ready for re-review @rmloveland. |
rmloveland
approved these changes
May 29, 2026
Contributor
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
thanks Eeshan, LGTM! please merge at will / ASAP
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
_includes/cockroach-generated/{% include %}instead of{% remote_include %}directivesThis is PR 7 of 10 splitting #23256 into reviewable chunks.
Jira: DOC-17061
Test plan
{% include cockroach-generated/... %}renders the same content as the old{% remote_include %}callsremote_includereferences to cockroachdb/cockroach🤖 Generated with Claude Code